/*
 *  Copyright (C) 2011 glauco
 * 
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 * 
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 * 
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.application;

import org.balisunrise.common.MenuAction;

/**
 * Folder de Menu. Contém Ações de Menu e outros Folders.
 * @author glauco
 */
public interface MenuFolder {

    /**
     * Nome do Folder.
     */
    public String getName();

    /**
     * Ações do Menu.
     */
    public MenuAction[] getActions();

    /**
     * Sub-Folders.
     */
    public MenuFolder[] getSubFolders();

    /**
     * Verifica se Contém um sub-folder pelo nome.
     * @param name nome do folder.
     * @return verdadeiro se o sub-folder exite.
     */
    public boolean containsFolder(String name);
    
    /**
     * Pega um sub-folder com o nome específico.
     * @param name nome do folder.
     * @return um folder com o nome específico, ou null se já existir.
     */
    public MenuFolder getSubFolder(String name);

    /**
     * Adiciona uma Ação de Menu ao Folder.
     */
    public void addAction(MenuAction action);

    /**
     * Cria um novo sub-folder.
     * @param name nome do folder.
     */
    public MenuFolder createFolder(String name);
}
